Summary
Inserts a button for the specified action. This component was added in version 5.1.
| Category | AS Workflow |
| Version | 1.1 |
| Complies with Xhtml 1.0 / 1.1 rules | Unspecified or not applicable |
| Supported server programming languages | Unspecified or not applicable |
| Output content type | Unspecified or not applicable |
When to use
The WF Perform Action component is used in editing templates working on documents managed by the workflow engine. The component interacts with the workflow server, and allow the user to perform different types of actions. The actions available for a certain user, on a certain document, at a certain time, depends on the state of the document and the workflow defitiotion (rules). The component can be configured to disable unavailable commands, or hide them. The componenent i similar to the EPT Button component, but it instead of communicating with the EPT Framework, it works in collaboration with the workflow server.
Programming interface
Parameters
- Action
- Select action
- StepName
- Select step name
- Comment
- Send comment
- CommentField
- Optional field to use for comment
-
- AlwaysDisplayButton
Always display button, even if action or step not available - DisplayButtonOnStep
Display button on active step even if action not available - DisplayButtonOnAction
Display button only if action available
- SetParticipants
- Set participants if participants are selectable
- DisplayName
- Optional display name
- Title
- Optional popup title
- Image
- Optional display image
- UseWFText
- Use WF text in button
- ClassName
- Class name
- Attributes
- Optional attributes
- PreScript
- Optional java script function to run before perform action. This event can be canceled if the function returns false.
- AfterScript
- Optional java script to run after perform action
Remarks
This component requires that the user is authenticated and that the Content Studio Workflow server is available and that the document edited is involved in a workflow.